/*
 * jngc, Java utility classes by Nicholas Coltharp
 * Copyright (C) 2010 Nicholas Coltharp <ngc1@rice.edu>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package edu.rice.ngc1.util;

import java.util.Collection;
import java.util.Iterator;

/**
 * Class containing utility methods for dealing with
 * {@link Collection}s.
 */
public final class Collections {

    /**
     * Private constructor to prevent construction.
     */
    private Collections() {}

    /**
     * Adds all of the items from a given {@code Iterable} into a
     * {@code Collection}.
     * 
     * @param <T>
     *            the element type of the given {@code Iterable} and
     *            {@code Collection}
     * @param <C>
     *            the type of the given {@code Collection}
     * @param c
     *            the {@code Collection} to add items to
     * @param i
     *            the {@code Iterable} to take items from
     * @return {@code c}
     */
    public static <T, C extends Collection<T>> C fillFromIterable(C c,
            Iterable<T> i) {
        return fillFromIterator(c, i.iterator());
    }

    /**
     * Adds all of the items from a given {@code Iterator} into a
     * {@code Collection}.
     * 
     * @param <T>
     *            the element type of the given {@code Iterator} and
     *            {@code Collection}
     * @param <C>
     *            the type of the given {@code Collection}
     * @param c
     *            the {@code Collection} to add items to
     * @param i
     *            the {@code Iterator} to take items from
     * @return {@code c}
     */
    public static <T, C extends Collection<T>> C fillFromIterator(C c,
            Iterator<T> i) {
        while (i.hasNext()) {
            c.add(i.next());
        }

        return c;
    }
}
